home *** CD-ROM | disk | FTP | other *** search
/ Software of the Month Club 1996 August / Software of the Month Club 1996 August.iso / pc / dos / edu / eviquiz / evidence.doc < prev    next >
Text File  |  1996-03-04  |  41KB  |  846 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.                                    EVIDENCES
  7.                                   version 2.6
  8.  
  9.                                Jean-Paul Doeraene
  10.                             13, rue marais Gauquier
  11.                            B-7911 Frasnes-Lez-Anvaing
  12.                                     BELGIUM
  13.  
  14.     EVIDENCES  is  a  quiz  game,  that is a game where  the  computer  asks
  15.     questions and the user answers.   The principle is quite simple, and the
  16.     idea  is not original.   But our aim is to give a flexible program  that
  17.     can do the most you want with the less needs.   Indeed,  you'll find  an
  18.     incredible  number  of options and configuration parameters which  allow
  19.     you  even to use the program with non english speaking pupils  while  on
  20.     the  other  hand you only need a simple XT computer and a 36O Ko  floppy
  21.     disk  unit.   We insist on the fact that this is *not* a multiple choice
  22.     quiz : the awaited answers are words or sentences.
  23.  
  24.     The program is divided in three main parts : 1) the game part, where the
  25.     computer  asks questions,  wait for answers and tells to the  user  (the
  26.     pupil) if he is right or not;  2) the edition part,  where the user (the
  27.     teacher) can edit its own questionnaires; 3) the attribution part, where
  28.     the user  (the  teacher)  can  assign  to  each  pupil  a  "program"  of
  29.     questionnaires   that  he will follow in one or more sessions while  his
  30.     results will be recorded by the program.
  31.  
  32.     HAVE MUCH FUN !
  33.  
  34.     Note  :  Each  paragraph  is noted with one,  two or  three  exclamation
  35.     points.   One for basic use level,  two for medium use level,  and three
  36.     for expert use level.
  37.  
  38.                               FIRST APPROACH  (!)
  39.  
  40.     You enter the program when you type "evidence",  followed by "Enter", at
  41.     the  DOS  prompt.   You  see then the main menu and  get  the  following
  42.     propositions   :   play   with  a  questionnaire,   edit  new   or   old
  43.     questionnaires,   manage  attributions,   manage  password  or  quit the
  44.     program. As a general rule, each expression after the ">>>" sign  points
  45.     out a command.
  46.  
  47.     We  want  to play first,  so we press "G" (for "game").   We see  now  a
  48.     screen  in  two  parts  :   the  left  part  shows  you  the list of the
  49.     questionnaires which are  available;   the  right  part  gives  you  two
  50.     propositions  :  select  a file or quit.   You press "Enter" to select a
  51.     file,  that is a questionnaire.   In the list you see  "DEMO.Q"  :   you
  52.     type  this  name  (you need  not to write the extension which is ".Q" by
  53.     default,  so  you  may simply type "demo").   After you have entered the
  54.     name  of  the  file,   the program asks you for the name of the player :
  55.     enter your firstname.  Now the game begins.   The screen is now  divided
  56.     in  three  parts  :   the  upper  part   for  asking questions and write
  57.     answers,  the lower left  part  to display available commands,  and  the
  58.     lower  right as a scoreboard.  In the upper part you see some question :
  59.     enter your answer and press "Enter". We suppose you are right,   so  the
  60.     computer  now  displays  "Right  answer!".  You  see  that  your   score
  61.     increases in the lower right part.   You can go  further   by   pressing
  62.  
  63.  
  64.                                                                             
  65.  
  66.  
  67.  
  68.                                                                             
  69.  
  70.  
  71.     the space bar.   The computer  asks  you   another  question,   and  you
  72.     answer  again.    If  your  answer  is wrong, the computer displays  the
  73.     right answer,  and the score of the  computer  increases. When  you  are
  74.     done,   the  computer  gives you a note between 0 and 20  and make  some
  75.     comment about your score.   You quit by pressing "End" and so  you  come
  76.     back to the file selection menu.
  77.  
  78.     Now  I suppose you want to edit your own questionnaire.   So  press  "Q"
  79.     (for  "Questionnaires") from the main menu.   Again you see the list  of
  80.     questionnaires  and you press "Enter" to select a file.   This time  you
  81.     will  enter a name which is not in the list,  so that a new file will be
  82.     created.   For instance type "MYQUEST" as a name for your questionnaire.
  83.     When  you press enter,  the program adds the extension ".Q" so the  name
  84.     will be "MYQUEST.Q".   As it doesn't exist,  the program asks you if you
  85.     want to create a new file;  press "Y" to confirm.   Now the program asks
  86.     you the number of lines for questions;  one is enough for this approach.
  87.     At last the program asks you  if the datas are as you want; press "Y" to
  88.     confirm.   Now you see a screen divided in three parts :  the upper  for
  89.     the  cards of the file and the lowers for instructions.   The upper part
  90.     is somewhat complicated at this moment because you see the card with the
  91.     title  of the file and its options.   Don't pay any attention  to  these
  92.     things for the moment; we'll go back to these in another paragraph.  Now
  93.     we  only want  to write questions and answers.   As pointed out  in  the
  94.     lower part,  you can edit a new card with one question and its answer by
  95.     pressing "N" (for "New").   When you do it, you see an empty card in the
  96.     upper  corner and the cursor is just near "Q :" which means that you can
  97.     type here your question.   Type it.   The line editor allows you to come
  98.     back with the left arrow,  or to erase characters with the backspace  or
  99.     "Del"  keys;  you can also erase the entire line with "F9"  or just  the
  100.     part from the cursor to the end of the line by "Ctrl-End".  When you are
  101.     done, press "Enter".  Now the cursor is near "A :" and you can write the
  102.     answer in the same way.   Press "Enter" again.  Now the program asks you
  103.     if  you want save the new card,  abort the modifications or edit  again.
  104.     Save  your card by pressing "S" (for "save").   Now you see that the new
  105.     card has got number 1 in the upper left corner of the screen.  To create
  106.     another card with another question and its answer, press "N" (for "new")
  107.     again,  and  repeat the process.   When all your questions are  written,
  108.     press "Q" (for "quit").   You see the list of questionnaires again,  and
  109.     you can notice that your questionnaire is now in the list.   Press "Esc"
  110.     to  go back to the main menu.   You can then press "G" (for  "game")  to
  111.     play with your own questionnaire.
  112.  
  113.     One more trick :  When editing a card,  you can also use the "PgDwn" key
  114.     ("Page Down") to go from the question to the answer,  and to go from the
  115.     answer to a new card (saving the former card at the same time).   So you
  116.     have no more to confirm the saving by "S" and ask for editing a new card
  117.     by "N".
  118.  
  119.                             HOW TO WRITE CARDS  (!)
  120.  
  121.     Of  course  you  can just write each question with one  answer.   But  a
  122.     simple  question can have more than one right answer.   For instance  if
  123.     your question is "Cite a yellow fruit",  then "lemon" is a right answer,
  124.     but "banana" is also right.   EVIDENCES can manage such problems; to use
  125.     it correctly,  you have to know how exactly it compares the answer given
  126.     by  the  player in game mode (let us call this the "given answer")  with
  127.  
  128.  
  129.                                                                             
  130.  
  131.  
  132.  
  133.                                                                             
  134.  
  135.  
  136.     the  answer  written on the card in edition mode (let us call  this  the
  137.     "expected answer").
  138.  
  139.     The  answer is accepted if each word in the expected answer (except some
  140.     little words :  "the",  "a", "an", "and") are in the given answer.  That
  141.     means that if the expected answer is "the red apple",  the program  will
  142.     accept the following given answers : "the red apple" of course, but also
  143.     "red  apple"  or "the apple red" or "apple red" or even "red and  yellow
  144.     apple";  it  will not accept "red pear" neither "apple" neither  "yellow
  145.     apple".   Though,  if you  think  that  "the  red  apple"  is  the  only
  146.     acceptable    answer,    then   you  have  to  set  the  option  "strict
  147.     comparison"  on (see the paragraph about options below).
  148.  
  149.     Now  what  about if your question has two or more acceptable  answers  ?
  150.     Well!  just  write them all separated by either the word "or" either "|"
  151.     or "||".  So for the question "Cite a yellow fruit", the expected answer
  152.     can be "banana or lemon" or "banana | lemon".  For the question "What is
  153.     the french translation of `dress' ?",  the expected answer can be "tenue
  154.     |  costume  | habit".   The program accepts the given answer "tenue"  or
  155.     else  "costume" or else "habit".   You can also use the  semi-colon  ";"
  156.     instead of "|".   The difference is that when the given answer is wrong,
  157.     any expected answer written after the first semi-colon is not displayed.
  158.     For instance, for the question "10 x 10 = ?", the expected answer can be
  159.     written  "100;  hundred".   In case of wrong answer,  the computer  will
  160.     display : "The right answer was : 100".
  161.  
  162.     Sometimes you want to add some explanation to the answer to be displayed
  163.     when the given answer is wrong.   You can add it to the expected  answer
  164.     in  brackets.   For instance for the question "In what year began  World
  165.     War  II  ?",  the expected answer can be "1940 (it ended in 1945)".  All
  166.     what is in brackets is ignored by the program so that the answer  "1940"
  167.     will be accepted,  but in case of wrong answer,  the information will be
  168.     displayed.
  169.  
  170.     If you add the sign "*" at the end of a word in the expected answer, the
  171.     program will accept each word beginning by the first one.  For instance,
  172.     if  "cell*" is the expected answer,  the program will accept "cell"  but
  173.     also "cellar",  "cello",  "cellophane",  etc.  As this special coding is
  174.     not comprehensive by the player,  it should be used only for alternative
  175.     answers  after the sign ";",  so that the words ending with  "*"  aren't
  176.     displayed in case of wrong answer.
  177.  
  178.     The  file "DEMO.Q" has been written using most of  these  possibilities.
  179.     Edit it to see how they are used.
  180.  
  181.     You  have  yet to know exactly what we mean by `word'.   A  word  is  an
  182.     unbroken sequence of letters,  which are the letters in strict sense but
  183.     also the chiffers, the underscore sign (_),  the apostrophe (') and  the
  184.     hyphen (-).  All other characters are separators.  It is possible to ask
  185.     to  the  program  to  consider  the  apostrophe  and/or  the  hyphen  as
  186.     separators : see the configuration parameter "SEPAR" described below.
  187.  
  188.                                   OPTIONS  (!)
  189.  
  190.     Each  questionnaire has a special card with the title and options.  This
  191.     card  is  displayed when you create a new  questionnaire.   When  it  is
  192.  
  193.  
  194.                                                                             
  195.  
  196.  
  197.  
  198.                                                                             
  199.  
  200.  
  201.     already  created,  you  can  go  to this card by the  command  "O"  (for
  202.     "option") or "T" (for "title").   You can edit this card just as you can
  203.     edit other cards with question and answer.   But you cannot delete  this
  204.     card.
  205.  
  206.     title
  207.         The title is used as a generic question.   It is  displayed  at  the
  208.         top  of the screen during the game.   For instance,  the title of  a
  209.         questionnaire  of  history can be "In what year was this event   ?",
  210.         the  title   of   a  questionnaire  of geography can be "What is the
  211.         capital  of this country ?".   When you  have  written  your  title,
  212.         press  "Enter"  to  go  to  options, or press "F2" to save the title
  213.         without editing options.
  214.  
  215.     repeat questions when wrong answer
  216.         This is the first option.   Type "Y" to set it on,  or "N" to set it
  217.         off,   or  press  "Enter"  to accept the option as  it  is  settled.
  218.         You can also use the up or down arrow  to  go   to  another  option.
  219.         If  you set this option off, each question will be asked at most one
  220.         time during the game.    If  you  set  this  option  on,   the  same
  221.         question   can   be   asked as long as the player doesn't  give  the
  222.         right answer.   Moreover, the number of  questions  to  ask  doesn't
  223.         decrease when this option is on, and the given answer is wrong.
  224.  
  225.     case of letter is significant
  226.         If you set this option off,  and if you  have  an  expected   answer
  227.         which  is "Event",  the program will accept "Event"  of course,  but
  228.         also "EVENT" or "event".   If you set this  option   on,   the  only
  229.         right answer will be "Event".
  230.  
  231.     the game may be aborted by "Esc"
  232.         After each question during the game, you can  continue  if you press
  233.         the  space  bar  or  stop  the  game if you  press "Esc".   If  this
  234.         option is off,  you can not stop the game  with  "Esc" before it  is
  235.         really finished.
  236.  
  237.     number of questions to ask
  238.         This option is a number between 0  and 255.  If you want the program
  239.         to  ask  all  questions  in  the questionnaire, leave this blank (or
  240.         equivalently set it to 0).  If you want the game to stop after  some
  241.         number  of  questions  (10,   15, 20, etc.), set this option to this
  242.         number.  If the option "ask again when wrong  answer"  is  off,  the
  243.         number  you enter will be exactly the number of questions asked.  If
  244.         this option is on,  the number you enter will be the number of right
  245.         answers to be given before the game ends.
  246.  
  247.     follow file order to ask questions
  248.         The cards are sorted out in the file :  When you use the command "N"
  249.         (as  "new  card"),   the  new   card will  be  set at the end of the
  250.         file;  when you use the command "I"  (as "insert  new  card"),   the
  251.         new  card  will  be  set before the current  card. This  is the only
  252.         difference between these two commands.   Now  when   you  set   "ask
  253.         questions  in  order" on,  the questions will be asked following the
  254.         order of the file; else they will be shuffled.
  255.  
  256.     strictly compare given answers
  257.  
  258.  
  259.                                                                             
  260.  
  261.  
  262.  
  263.                                                                             
  264.  
  265.  
  266.         Let's explain this option  by  an  example.    Assume  the  expected
  267.         answer  is  "an  apple  and  a  pear".   If this option is off,  the
  268.         following answers will be accepted :  "an apple and  a   pear",   of
  269.         course,   but  also "apple and pear",  "a pear  and  an apple",  and
  270.         even  "pear apple" (see also the  configuration   parameter  "ignor"
  271.         below).    If this option is on, the following answers will *not* be
  272.         accepted :  "apple and pear" (this miss the articles), "a  pear  and
  273.         an  apple"  (the  words are shuffled) and even "an apple and a  pear
  274.         and  a banana" (two much words).
  275.  
  276.     current best score settled to
  277.         This is not really an option;  it is  the best  score which has been
  278.         recorded  by  the program itself for the  file. There is two reasons
  279.         for which you may want to modify it :  the first is that you want to
  280.         reset  this  best  score,  then set it to 0; the second is that  you
  281.         don't want to record and display best scores,  then set it  to 21 (a
  282.         score that can not been reached, because the top score is 20).
  283.  
  284.     threshold to go on in attribution
  285.         This option is only  useful when you use the file in an  attribution
  286.         list  (see  below).   The game will be stopped before the end of the
  287.         list if the score you enter here is not reached by the player.
  288.  
  289.                                ATTRIBUTIONS  (!!)
  290.  
  291.     This  function can be used by teachers.   It allows to assign a list  of
  292.     questionnaires  to pupils,  either individually either  by  group.   The
  293.     pupil  is then asked to answer to each questionnaire of the  list.   The
  294.     program  take a note of which questionnaires have been done,  and  which
  295.     have  not  been done,  so that the pupil can resume its work in  another
  296.     session.   So  progressive programs can be established.   Moreover  each
  297.     questionnaire have a minimum score ("threshold") which has to be reached
  298.     by the pupil before to go to the next questionnaire;  otherwise, he will
  299.     have to carry out the same questionnaire again next time.
  300.  
  301.     To proceed,  press "A" (for "attributions") from the main menu.  Now you
  302.     see  a  list of files with extension ".A";  these  are  the  attribution
  303.     files.   (If you use EVIDENCES for the first time, the list has probably
  304.     only one file "DEMO.A".)
  305.  
  306.     To  create your own attribution file press "Enter" to select a file  and
  307.     type for instance "MYATTRIB" as a name for your file.  When you validate
  308.     by  "Enter",  the program adds the extension ".A",  so your file will be
  309.     "MYATTRIB.A".   Confirm that you want to create a new file and that  the
  310.     datas  are  correct  by pressing "Y" (for "yes").   Now  you  enter  the
  311.     edition.   This is quite the same way as the edition of a questionnaire.
  312.     Though  instead of fields "Q" ("question") and "A" ("answer"),  you have
  313.     now fields "N" ("name of the player") and "A" ("attribution list").   So
  314.     each  card  has a field with the name of the pupil and a field  for  the
  315.     list  of questionnaires which you assign to this pupil.   You can  enter
  316.     more than one name on a card,  separated by the sign ";" or "|"   :  for
  317.     instance  you  can enter "John Smith;  John" so that John Smith will  be
  318.     recognized later by his surname only (of course this means that you  can
  319.     not  have two John in your classroom !).   The list of questionnaires is
  320.     just  the names of the files (with or without extension ".Q")  separated
  321.     by  spaces.   For instance it can be "planets gwashing french1"  if  you
  322.  
  323.  
  324.                                                                             
  325.  
  326.  
  327.  
  328.                                                                             
  329.  
  330.  
  331.     want   John  to  answer  to  a  questionnaire  about  astronomy   (named
  332.     "PLANETS.Q"),  then  a questionnaire about history (named  "GWASHING.Q")
  333.     and  a questionnaire about french vocabulary (named "FRENCH1.Q") that we
  334.     assume  you have edited before,  of course.   You create a card for  all
  335.     pupil in your classroom.   When you are done,   quit the edition by  the
  336.     command "Q" (for "quit").
  337.  
  338.     Now  that your attribution file has been created,  you can activate  it.
  339.     To do this,  just select the file "MYATTRIB.A" again, and press "A" (for
  340.     "activate").   The  program  now mentions that the attribution  file  is
  341.     active.  Return to the main menu by "Esc".
  342.  
  343.     In the main menu you see "(Y)" near the word "Attributions" which  means
  344.     that  there is an attribution file activated.   Press "G" (for  "game").
  345.     The  program does not display the list of files  anymore.   Instead,  it
  346.     asks  you your name.   Type it and press "Enter".   The program  display
  347.     "Unknown  player  !".   Indeed  you  are not  in  the  attribution  file
  348.     "MYATTRIB.A".   If you try again but type the name of one of your pupils
  349.     - assume you type "Smith" - the program will ask you the  questionnaires
  350.     of the list of files attributed to Smith :  planets, gwashing,  french1.
  351.     Assume you answer theses questions.   Thereafter,  the program quits the
  352.     game  and displays "There is no more questionnaire for you".   From  the
  353.     main menu, type "A" (for "attribution") and select "MYATTRIB.A" again to
  354.     edit it.  In the file, you see that the index card of John Smith has now
  355.     its  attribution  field  modified  :   it's  something  as  "planets(12)
  356.     gwashing(11)  french1(5)".  The  numbers between brackets are the  score
  357.     that you have obtained during the game.
  358.  
  359.     If John Smith want to play again, the program will now display "There is
  360.     no more questionnaire for you".   But suppose you have aborted the  game
  361.     (by  "Esc")  while  you were answering to the questions  of  "gwashing".
  362.     Then  the index card of John will be recorded as  "planets(12)  gwashing
  363.     french1".  When he will try to play in another session of EVIDENCES, the
  364.     program  will then ask him the questions of "GWASHING.Q" and "FRENCH1.Q"
  365.     only.   (The  program  "knows" that the  questionnaire  "PLANETS.Q"  has
  366.     already been achieved by John because there is a number between brackets
  367.     after "planet" in the attribution file.)
  368.  
  369.     If  you want to come back to the normal mode for the game,  you have  to
  370.     choose  "Attributions" again from the main menu,  and then  "Desactivate
  371.     attribution".
  372.  
  373.     There  is  a way to conceive progressive programs of  questionnaires  by
  374.     limiting   the  access  of  the  next  questionnaire  in  the list. Each
  375.     questionnaire  has a passing score ("threshold")  as  option  which  the
  376.     player  must  cross to go to the next questionnaire in the list.  In our
  377.     example,  let  us  suppose  we  have  set  the  threshold  of  the  file
  378.     "PLANETS.Q"  to   12.  If John has got a score of 11 for this file,  the
  379.     program will abort the list,  and  will  not record the score,  so  that
  380.     John will be  asked  to answer to the questionnaire "PLANETS.Q" again in
  381.     the next session.
  382.  
  383.     Two  more  tricks.  1)   Often you want to attribuate the same  list  of
  384.     questionnaires to a whole classroom.  You can avoid typing the same list
  385.     again and again.   Just enter the names of the pupils on cards,  leaving
  386.     the  attribution  field blank.   Then choose the  "General  attribution"
  387.  
  388.  
  389.                                                                             
  390.  
  391.  
  392.  
  393.                                                                             
  394.  
  395.  
  396.     function,  and  type  the list of questionnaires  you want to assign  to
  397.     everybody.   2) Instead,  if you want just establish a list for everyone
  398.     but don't want individual cards, you can create an attribution file with
  399.     one card only,  leaving the name field blank,  and with this list in the
  400.     attribution  field.   So,  everybody  will be asked this list,  but  the
  401.     scores won't be recorded in the attribution file.
  402.  
  403.                                SCORES FILE  (!!)
  404.  
  405.     Each  time a player has answered completely to a questionnaire  (without
  406.     leaving it with "Esc"),  EVIDENCES records his name, the file, his score
  407.     and  the  date in a text file "SCORES.TXT".   This file is a plain  text
  408.     file.  EVIDENCES cannot show you this file, but you can see it by typing
  409.     "more  < SCORES.TXT" at the DOS prompt,  or with any text  editor  (like
  410.     EDIT)  or  text viewer.   You can delete the file "SCORES.TXT" when  you
  411.     want  (if becomes bigger and bigger) ;  then the program EVIDENCES  will
  412.     create a new one next time you'll play with it.
  413.  
  414.     If  you  want  to import the datas of "SCORES.TXT" in  a  worksheet  (as
  415.     EXCEL),  you'll  better add the line "TABSC = Yes" to the  configuration
  416.     file (see below),  so that the fields of SCORES.TXT will be separated by
  417.     tabulations instead of spaces.
  418.  
  419.                                  PASSWORD  (!!)
  420.  
  421.     You  can  introduce  a  password  that  limits  access  to  edition  and
  422.     attribution  modes.    So  when  a password is introduced,  you can just
  423.     play but not  modify  files.   This is useful if you are a  teacher  and
  424.     use  this program with pupils.
  425.  
  426.     The  first time you press "P" in the main menu,  the program asks you  a
  427.     new  password.   After  you have done this,  the program  will  ask  the
  428.     password each time you attempt to edit files.
  429.  
  430.     You can change the password choosing "P" again from the main  menu.   If
  431.     you  want to erase the password,  you just have to enter an empty string
  432.     as a new password.
  433.  
  434.     The password is kept in a hidden file named "MDP".  This file is deleted
  435.     when  you  erase the password inside the program.   If you  forget  your
  436.     password, you can delete this file under DOS, but you have to cancel the
  437.     hidden attrib of the file before with the command "attrib -h mdp".
  438.  
  439.     If  you don't want to erase the password but want to get rid of  writing
  440.     it  during a complete session of EVIDENCES,  you just have to  enter  it
  441.     when it is asked you, and enter it with "F2" instead of "Enter".
  442.  
  443.                                SECRET KEYS  (!!)
  444.  
  445.     During the game,  when the program asks you if you want to resume, after
  446.     you  have answered a question and the program has corrected your answer,
  447.     you can use some secret keys.   If you have entered a password,  it will
  448.     be asked you when you try to use these cheat keys.
  449.  
  450.     Ctrl-A
  451.         This forces the program to accept your  answer  even  if   you  were
  452.  
  453.  
  454.                                                                             
  455.  
  456.  
  457.  
  458.                                                                             
  459.  
  460.  
  461.         wrong.
  462.  
  463.     Ctrl-C
  464.         This ends the game.
  465.  
  466.     Ctrl-E
  467.         This goes directly to edition mode.   This is useful   when  testing
  468.         a   new   questionnaire   if  you  see you have made  a  mistake  in
  469.         writing  the card.   You can correct it directly,  and come back  to
  470.         the game when you press "Q".
  471.  
  472.                            CONFIGURATION FILE  (!!!)
  473.  
  474.     You  can  configure  the  program completely  to  your  needs  with  the
  475.     configuration  file "CONFIG.EVI" which is a text file that you can  edit
  476.     with  a  plain text editor such as EDIT which is supplied with your  DOS
  477.     system.
  478.  
  479.     Each line of the file is something like "<ID> = <parameter>".  The ID is
  480.     a single word.  The parameter is sometimes simply "yes" or "no" (this is
  481.     a switch), sometimes a text.  Here is the list of the IDs.
  482.  
  483.     Note : Examples between quotation marks below must appear  on  a  single
  484.     line  in the configuration file, although they may split on two lines in
  485.     this documentation file.
  486.  
  487.     REM
  488.         Line ignored by the program ; this is just to introduce a REMark  in
  489.         your configuration file. Example : "REM = This is a remark."
  490.  
  491.     IGNOR
  492.         Words   IGNORed   by   the  program   when   the   option    "strict
  493.         comparison" is off.  Example : "IGNOR = the an a and".
  494.  
  495.     PLAYE
  496.         Name of the usual PLAYEr if any (15 characters or less).
  497.  
  498.     SIGNA
  499.         Each  created  file  can  be  marked  with   your   SIGNAture    (20
  500.         characters or less).  Example : "SIGNA = Jean-Paul Doeraene".
  501.  
  502.     DELAY
  503.         Some messages appear on screen for a while and then  disappear.   If
  504.         the  time  they  appear  is  too  short  (because  you  have  a fast
  505.         computer), you can increase it.  Default delay is 2.  Example "DELAY
  506.         = 4".
  507.  
  508.     FEXIT
  509.         Switch.   When a password exists,  you can quit the  program freely.
  510.         You  can  forbit the Free EXIT if you write "FEXIT = No".  If you do
  511.         so,  and if a password exists,  you'll have to write the password to
  512.         quit the program.
  513.  
  514.     CHPAS
  515.         Switch.   Maybe   you  don't  want  all  the   business   with   the
  516.         password.    In  this  case  you can forbit the set (or  CHange)  of
  517.  
  518.  
  519.                                                                             
  520.  
  521.  
  522.  
  523.                                                                             
  524.  
  525.  
  526.         the PASsword if you write "CHPAS = No".
  527.  
  528.     SEPAR
  529.         The hyphen and apostrophe are considered as letters.  You can  force
  530.         the   program   to  consider they are SEPARators  (which  means  not
  531.         letters) in any case.  Examples : "SEPAR = - '" if you want both the
  532.         hyphen  and  apostrophe  to be separators or "SEPAR = '" if you want
  533.         the apostrophe to be a separator and the hyphen to be a letter.
  534.  
  535.     CTRLA
  536.         Switch.   You can forbit the use of the cheat  key  "CTRL-A"  during
  537.         the game with "CTRLA = No".
  538.  
  539.     DITOP
  540.         Switch.   You can forbit the DIsplay and record of the   TOP  player
  541.         with "DITOP = No".
  542.  
  543.     DANSW
  544.         Switch.   If you insert the line "DANSW = Yes",   then   the  editor
  545.         will  ask  you  if you want answers with one or two lines.   If  you
  546.         chose  two lines,  you will have two lines  for  the  field  of  the
  547.         answer.  Note,  however,  that  the player will always have one line
  548.         only to answer, and in case of wrong answer,  the first line of  the
  549.         expected answer only will be displayed.  So what is the utility of a
  550.         second line ? Well ! you can  use it to add  more  possible  answers
  551.         (don't forget to end the  first line by a semi-colon ";").
  552.  
  553.     SCORE
  554.         Name  of the text file where the  SCOREs  must  be  stored.  Example
  555.         :  "SCORE  =  SCOBOARD.TXT".   If you don't want that the scores are
  556.         stored in a file, just enter "SCORE =" (without file name).  Path is
  557.         not  allowed  : the file will always be in the same directory as the
  558.         questionnaires.
  559.  
  560.     TABSC
  561.         Switch.  If you write "TABSC = Yes" in the configuration file,  then
  562.         the  fields in the SCore file (i.e. the name of the player, the name
  563.         of  the file,   the  score  and  the  date)  will  be  separated  by
  564.         TABulations  instead   of by spaces.   This is useful if you want to
  565.         use the datas  of the score file within a worksheet.
  566.  
  567.     ATTRI
  568.         Name of the file that is activated as an ATTRIbution file  when  the
  569.         program starts (you *have* to write the extension ".A").   With this
  570.         you have no longer to activate it via the attribution mode.  Path is
  571.         not  allowed   :   the  file should be in the same directory as  the
  572.         questionnaires.
  573.  
  574.     WDIR
  575.         Path for questionnaires,   attribution  files  and  scores  file  if
  576.         different from the current directory.
  577.  
  578.     COMME
  579.         Name   of   the  file  that  countains  the   COMMEnts   which   are
  580.         displayed   where  the  game is finished.   The comments  are  lines
  581.         (35 characters  or less) in decreasing  order  of  score.    If  you
  582.  
  583.  
  584.                                                                             
  585.  
  586.  
  587.  
  588.                                                                             
  589.  
  590.  
  591.         don't  want that the scores are  commented,  just  enter  "COMME  ="
  592.         (without  file  name). Path  is not allowed :  the file should be in
  593.         the same directory as  the program "EVIDENCE.EXE".
  594.  
  595.     VIDEO
  596.         Name of the file used  by  the  program  for  the  VIDEO  parameters
  597.         instead  of  the default one.   Path is not allowed :  the file must
  598.         be in the  same  directory  as  "EVIDENCE.EXE".    By  default,  the
  599.         program uses either "COLOUR.EVI" either "MONOCHRO.EVI".
  600.  
  601.     UPCAS
  602.         Name of the file used by the program for the UPCASe  conversion.  By
  603.         default   the   program   uses  one   of   the   UPCxxx.EVI   files,
  604.         depending of what code page you have.  So you should not worry about
  605.         this.
  606.  
  607.     The  next parameters allow you to change a lot of messages displayed  by
  608.     the program in game mode.   This is especially useful if you want to use
  609.     this program with non english speaking players.
  610.  
  611.     OR
  612.         You can change the word to separate  expected  answers.   Example  :
  613.         "OR = ou" to use french questionnaires.
  614.  
  615.     SORRY
  616.         Text displayed when the answer is wrong (60  characters   or  less).
  617.         Example : "SORRY = Sorry ! This is not right !"
  618.  
  619.     CONGR
  620.         Text  displayed when the answer is true (60  characters   or  less).
  621.         Example : "CONGR = Right answer !"
  622.  
  623.     BEST
  624.         Text displayed when the BEST score  is  reached  (35  characters  or
  625.         less).  Example : "BEST = Best score !"
  626.  
  627.     WNAME
  628.         Text displayed when the program has to ask for  the   player's  name
  629.         (35  characters or less, attribution mode only).  Example : "WNAME =
  630.         What is your name ?"
  631.  
  632.     UNKNO
  633.         Text displayed when the program doesn't  recognize  the  player  (35
  634.         characters  or less,  attribution mode only).  You can  display  two
  635.         lines (35 characters each); just enter the whole text (on  a  single
  636.         line)  in  the config file and write "\" where you want a linebreak.
  637.         Example : "UNKNO = I don't recognize\this name !".
  638.  
  639.     NOMOR
  640.         Text displayed when the list of  questionnaire  of  the  attribution
  641.         file   is   done  (attribution  mode  only).   One or two  lines (35
  642.         characters  each),  with "\" as linebreak.    Example  :   "NOMOR  =
  643.         That's all,\folks !".
  644.  
  645.  
  646.     NOTHR
  647.  
  648.  
  649.                                                                             
  650.  
  651.  
  652.  
  653.                                                                             
  654.  
  655.  
  656.         Text displayed when the threshold  is  not  reached  by  the  player
  657.         (attribution  mode  only).   One or two lines (35 characters  each),
  658.         with "\" as linebreak.  Example : "NOTHR = Sorry\Not enough to go on
  659.         !".
  660.  
  661.     INTER
  662.         Text   displayed  when  the  user  has  INTERrupted  the   list   of
  663.         questionnaires  (attribution  mode  only).   One  or  two  lines (35
  664.         characters each), with "\" as linebreak.  Example  :  "INTER  =  You
  665.         requested\to leave the game !".
  666.  
  667.     DFPLA
  668.         Name of the player when no name is  introduced.   Example  "DFPLA  =
  669.         player".
  670.  
  671.     OPPON
  672.         Name of the virtual  OPPONent  to  the  player.   Example  "OPPON  =
  673.         computer".
  674.  
  675.                                 PARAMETERS  (!!)
  676.  
  677.     EVIDENCES accepts some parameters on the command line.  You have a quick
  678.     reminder  if you type "evidence /?" at the DOS prompt.   Each  parameter
  679.     has  the form "<ID>=<parameter>" (without spaces).   The ID is a  single
  680.     letter and the parameter is a string.
  681.  
  682.     For instance you can activate the attribution file "DEMO.A" directly  if
  683.     you  type  "evidence  a=demo.a"  at the DOS  prompt.   You  can  use  an
  684.     alternative  configuration  file  "FCONFIG.EVI" if you  enter  "evidence
  685.     c=fconfig.evi".   You can set a signature for the new files if you enter
  686.     "evidence i=Jean-Paul_Doeraene" (note the sign "_" instead of a  space).
  687.     Of course you can use several parameters.
  688.  
  689.                                  EVI2TXT  (!!!)
  690.  
  691.     This  is  a  stand-alone utility to translate EVIDENCES  files  to  text
  692.     files.   The complete syntax is reminded to you when you run the program
  693.     without parameters.
  694.  
  695.     Here  are some examples.   To display the questionnaire "DEMO.Q" on  the
  696.     screen  page by page,  enter "evi2txt demo.q | more" at the DOS  prompt.
  697.     To   write   the   attribution  file  "MYATTRIB.A"  to   a   text   file
  698.     "MYATTRIB.TXT",  enter  "evi2txt myattrib.a /v myattrib.txt".   To write
  699.     the  complete description of the questionnaire "CAPITAL.Q" to  the  text
  700.     file "CAPITAL.TXT", enter "evi2txt capital.q /v capital.txt /c".
  701.  
  702.                         FILES USED BY THE PROGRAM  (!!!)
  703.  
  704.     EVIDENCE.EXE
  705.         This is of course the main program.
  706.  
  707.     CONFIG.EVI
  708.         This file is a text file that contains  custom  parameters  for  the
  709.         program.  See above.
  710.  
  711.     MONOCHRO.EVI and COLOUR.EVI
  712.  
  713.  
  714.                                                                             
  715.  
  716.  
  717.  
  718.                                                                             
  719.  
  720.  
  721.         These files  contain   parameters  for  the  video   display.    The
  722.         program  determines  itself  if  you  have  a  monochrome  or colour
  723.         adaptater and uses the appropriate file.   The  file   "CGA.EVI"  is
  724.         an alternative file for colour display :  write "video = cga.evi" in
  725.         the "CONFIG.EVI" file if you want the program to use it.
  726.  
  727.     COMMENTS.EVI
  728.         This is a text file used to comment the scores  (game mode).    Each
  729.         line  (35  characters  or less) contains the comment for  one score.
  730.         The first line is for the score 20,  the second is for 19, etc.  You
  731.         can change this file with a plain text editor.
  732.  
  733.     UPCxxx.EVI
  734.         These files are used only if you don't use the  standard  code  page
  735.         437.    You  can check the code page used by your computer  with the
  736.         command  line  "chcp" at the DOS prompt.   The  program   determines
  737.         itself what code page you use, and uses the appropiate file.
  738.  
  739.     SCORES.TXT
  740.         This text file is maintained by the program to  keep  a trace of the
  741.         scores  which  have been established by the players.  You can see it
  742.         with a simple text editor or viewer, or print it  with  the  command
  743.         line "copy scores.txt prn:" at the DOS prompt.   Note that the score
  744.         is not  recorded if the game is interrupted before the normal end by
  745.         "Esc". You can delete the file without fear when you want.
  746.  
  747.     MDP
  748.         This is an hidden file that is maintained by the program to keep the
  749.         password if any.  It will be deleted if you delete the password.
  750.  
  751.     EVI2TXT.EXE
  752.         This is a stand-alone utility  to  write  EVIDENCES  files  to  text
  753.         files.    If you run it without parameters,  you get a quick help of
  754.         the syntax and options of this program.
  755.  
  756.                                    DISCLAIMER
  757.  
  758.     This  software  and  any support from author are provided  "as  is"  and
  759.     without warranty, express or implied.  Author specifically disclaims any
  760.     implied  warranties  of  merchantability and fitness  for  a  particular
  761.     purpose.   In no event will author be liable for any damages,  including
  762.     but  not limited to any lost profits,  lost savings or any incidental or
  763.     consequential  damages,  whether resulting from impaired or  lost  data,
  764.     software or computer failure or any other cause,  or for any other claim
  765.     by user or for any third party claim.
  766.  
  767.                                    CONCLUSION
  768.  
  769.     You can ask questions or just say me you like (or don't like) my program
  770.     by  the following means.  (Please say me where you have found  EVIDENCES
  771.     and which version you have.)  What I'd like the best, is to receive quiz
  772.     files that *you* created ;  you can use the util EVI2TXT with the option
  773.     "/c" to write your file as a text file and send it me this with e-mail ;
  774.     if  you  do  this,  you  implicitely accept  that  your  file  could  be
  775.     distibuted with a future version of EVIDENCES.
  776.  
  777.  
  778.  
  779.                                                                             
  780.  
  781.  
  782.  
  783.                                                                             
  784.  
  785.  
  786.     The  next  version  of  EVIDENCES should be 3.0.   It should  not  be  a
  787.     freeware  anymore,  but  a low cost shareware (no more  than  $29).   It
  788.     should  have two major improvements :  1) The edition of questions  with
  789.     more than one line will have an automatic word wrap,  as in a true  text
  790.     editor.  2) The program could be used with a network,  meaning that many
  791.     pupils  could  play with the same file at the same time,  and share  the
  792.     same attribution file.   If you are interested by this project,  or have
  793.     any idea for other improvements, please write it to me.
  794.  
  795.     Mail :
  796.     Jean-Paul Doeraene
  797.     13, rue du marais Gauquier
  798.     B-7911 Frasnes-Lez-Anvaing
  799.     BELGIUM
  800.  
  801.     E-mail :
  802.     CompuServe : 100415,2113
  803.     Internet :   Doeraene@univ-lille1.fr
  804.  
  805.  
  806.  
  807.  
  808.  
  809.  
  810.  
  811.  
  812.  
  813.  
  814.  
  815.  
  816.  
  817.  
  818.  
  819.  
  820.  
  821.  
  822.  
  823.  
  824.  
  825.  
  826.  
  827.  
  828.  
  829.  
  830.  
  831.  
  832.  
  833.  
  834.  
  835.  
  836.  
  837.  
  838.  
  839.  
  840.  
  841.  
  842.  
  843.  
  844.                                                                             
  845.  
  846.